Snapservice Reports Clusters ProtectionGroups Snapshots ListItem

Snapservice Reports Clusters ProtectionGroups Snapshots ListItem
Snapservice Reports Clusters ProtectionGroups Snapshots ListItem

The Snapservice Reports Clusters ProtectionGroups Snapshots ListItem schema contains information about a protection group snapshot returned by GET /snapservice/reports/clusters/{cluster}/protection-groups/snapshots operation

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "pg": "string",
    "name": "string",
    "snapshot": "string",
    "status": "string",
    "errors": [
        {
            "messages": [
                {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            ]
        }
    ],
    "warnings": [
        {
            "messages": [
                {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            ]
        }
    ],
    "creation_time": "string",
    "expiration_time": "string",
    "snapshot_type": "string",
    "deleted": false
}
string
pg
Required

ID of the protection group.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.snapservice.protection_group. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.snapservice.protection_group.

string
name
Required

Name of the protection group snapshot. If no snapshot is available for pg due to error, a dummy name will be returned.

This property was added in vSphere API 9.0.0.0.

string
snapshot
Optional

Identifier of the protection group snapshot.

This property was added in vSphere API 9.0.0.0.

If missing or null no snapshot is available for pg due to error.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.snapservice.protection_group.snapshot. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.snapservice.protection_group.snapshot.

string
status
Required

Status of the protection group snapshot operation.

For more information see: Snapservice Reports Clusters ProtectionGroups Snapshots Status.

This property was added in vSphere API 9.0.0.0.

array of Snapservice Reason
errors
Optional

List of snapshot operation errors for the protection group.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of status is Snapservice Reports Clusters ProtectionGroups Snapshots Status.ERROR.

array of Snapservice Reason
warnings
Optional

List of snapshot operation warnings for the protection group.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of status is Snapservice Reports Clusters ProtectionGroups Snapshots Status.WARNING.

string As date-time As date-time
creation_time
Required

Creation time of protection group snapshot. Time is in UTC format. If the snapshot operation fails, start time of the operation is returned.

This property was added in vSphere API 9.0.0.0.

string As date-time As date-time
expiration_time
Optional

Expiration time of protection group snapshot. Time is in UTC format.

This property was added in vSphere API 9.0.0.0.

If missing or null no expiry time is set for the protection group snapshot.

string
snapshot_type
Optional

Type of protection group snapshot.

For more information see: Snapservice Clusters ProtectionGroups Snapshots Type.

This property was added in vSphere API 9.0.0.0.

If missing or null snapshot and its type is not available for pg due to error.

boolean
deleted
Required

Whether the protection group snapshot is deleted.

This property was added in vSphere API 9.0.0.0.

Property Of